<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->
<title>cxref</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<h4><a name = "tag_001_014_320">&nbsp;</a>NAME</h4><blockquote>
cxref - generate a C-language program cross-reference table
(<b>DEVELOPMENT</b>)
</blockquote><h4><a name = "tag_001_014_321">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

cxref <b>[</b>-cs<b>][</b>-o <i>file</i><b>][</b>-w <i>num</i><b>] [</b>-D <i>name</i><b>[</b>=<i>def</i><b>]]</b>...<b>[</b>-I <i>dir</i><b>]</b>...<b>[</b>-U <i>name</i><b>]</b>...
<i>file</i> ...
</code>
</pre>
</blockquote><h4><a name = "tag_001_014_322">&nbsp;</a>DESCRIPTION</h4><blockquote>
The
<i>cxref</i>
utility
analyses a collection of C-language
<i>file</i>s
and attempts to build a cross-reference table.
Information from
<b>#define</b>
lines is included in the symbol table.
A sorted listing is written to standard output of all symbols (auto, static
and global) in each
<i>file</i>
separately, or with the
<b>-c</b>
option, in combination.
Each symbol
contains an asterisk before the declaring reference.
</blockquote><h4><a name = "tag_001_014_323">&nbsp;</a>OPTIONS</h4><blockquote>
The
<i>cxref</i>
utility supports the <b>XBD</b> specification, <a href="../xbd/utilconv.html#usg"><b>Utility Syntax Guidelines</b>&nbsp;</a> ,
except that the order of the
<b>-D</b>,
<b>-I</b>
and
<b>-U</b>
options (which are identical to their interpretation by
<i><a href="c89.html">c89</a></i>)
is significant.
The following options are supported:
<dl compact>

<dt><b>-c</b>
<dd>Write a combined cross-reference of all input files.

<dt><b>-w&nbsp;</b><i>num</i>
<dd>
Format output no wider than
<i>num</i>
(decimal) columns.
This option defaults to 80 if
<i>num</i>
is not specified or is less than 51.

<dt><b>-o&nbsp;</b><i>file</i>
<dd>Direct output to named
<i>file</i>.

<dt><b>-s</b>
<dd>Operate silently; do not print input filenames.

</dl>
</blockquote><h4><a name = "tag_001_014_324">&nbsp;</a>OPERANDS</h4><blockquote>
The following operand is supported:
<dl compact>

<dt><i>file</i><dd>A pathname of a C-language source file.

</dl>
</blockquote><h4><a name = "tag_001_014_325">&nbsp;</a>STDIN</h4><blockquote>
Not used.
</blockquote><h4><a name = "tag_001_014_326">&nbsp;</a>INPUT FILES</h4><blockquote>
The input files are C-language source files.
</blockquote><h4><a name = "tag_001_014_327">&nbsp;</a>ENVIRONMENT VARIABLES</h4><blockquote>
The following environment variables affect the execution of
<i>cxref</i>:
<dl compact>

<dt><i>LANG</i><dd>Provide a default value for the internationalisation variables
that are unset or null.
If
<i>LANG</i>
is unset or null, the corresponding value from the
implementation-dependent default locale will be used.
If any of the internationalisation variables contains an invalid setting, the
utility will behave as if none of the variables had been defined.

<dt><i>LC_ALL</i><dd>
If set to a non-empty string value,
override the values of all the other internationalisation variables.

<dt><i>LC_COLLATE</i><dd>
Determine the locale for the ordering of the output.

<dt><i>LC_CTYPE</i><dd>
Determine the
locale for the interpretation of sequences of bytes of text data as
characters (for example, single- as opposed to multi-byte characters
in arguments and input files).


<dt><i>LC_MESSAGES</i><dd>
Determine the locale that should be used to affect
the format and contents of diagnostic
messages written to standard error.

<dt><i>NLSPATH</i><dd>
Determine the location of message catalogues
for the processing of
<i>LC_MESSAGES .
</i>
</dl>
</blockquote><h4><a name = "tag_001_014_328">&nbsp;</a>ASYNCHRONOUS EVENTS</h4><blockquote>
Default.
</blockquote><h4><a name = "tag_001_014_329">&nbsp;</a>STDOUT</h4><blockquote>
The standard output is used for the cross-reference listing,
unless the
<b>-o</b>
option is used to select a different output file.
<p>
The format of standard output is unspecified,
except that the following information is included:
<ul>
<p>
<li>
If the
<b>-c</b>
option is not specified, each portion of the listing starts
with the name of the input file on a separate line.
<p>
<li>
The name line is followed by a sorted list of symbols, each
with its associated location pathname, the name of the function
in which it appears (if it is not a function name itself),
and line number references.
<p>
<li>
Each line number may be preceded by an asterisk
(*)
flag, meaning
that this is the declaring reference.
Other single-character flags, with implementation-dependent
meanings, may be included.
<p>
</ul>
</blockquote><h4><a name = "tag_001_014_330">&nbsp;</a>STDERR</h4><blockquote>
Used only for diagnostic messages.
</blockquote><h4><a name = "tag_001_014_331">&nbsp;</a>OUTPUT FILES</h4><blockquote>
The output file named by the
<b>-o</b>
option is used instead of standard output.
</blockquote><h4><a name = "tag_001_014_332">&nbsp;</a>EXTENDED DESCRIPTION</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_333">&nbsp;</a>EXIT STATUS</h4><blockquote>
The following exit values are returned:
<dl compact>

<dt>0<dd>Successful completion.

<dt>&gt;0<dd>An error occurred.

</dl>
</blockquote><h4><a name = "tag_001_014_334">&nbsp;</a>CONSEQUENCES OF ERRORS</h4><blockquote>
Default.
</blockquote><h4><a name = "tag_001_014_335">&nbsp;</a>APPLICATION USAGE</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_336">&nbsp;</a>EXAMPLES</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_337">&nbsp;</a>FUTURE DIRECTIONS</h4><blockquote>
None.
</blockquote><h4><a name = "tag_001_014_338">&nbsp;</a>SEE ALSO</h4><blockquote>
<i><a href="cc.html">cc</a></i>,
<i><a href="c89.html">c89</a></i>.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>
